Back to Main Menu

Applying Assessment Form Results

Sample Script

This example below outlines how to take a set of data and assign to an assessment form as an 'Assessment Form Result'. The 'Assessment Form Result' is then assigned to an assessment task. For a more general overview of the application of assessment form results, please refer to this article on the Integration section.

  1. """
  2. Example script to apply an assessment result to a task
  3. (Assetic.Assessments.py)
  5. 1. create (POST) a form result.
  6. 2. use the generated ID in form result response to link to the
  7. assessment task
  8. """
  9. import assetic
  10. from datetime import datetime
  11. from datetime import timedelta
  12. #Assetic SDK instance
  13. asseticsdk = assetic.AsseticSDK('c:/users/you/assetic.ini',None,'Error')
  14. #assessment form result API
  15. assessresultapi = assetic.AssessmentFormResultApi()
  17. ##need some identifiers. These may come from GET /api/v2/assessmenttask
  18. ##which is in the AssessmentTaskApi, use method assessment_task_get which
  19. ##returns all tasks assigned to the logged in user
  20. taskguid = '375f575c-2b6b-e611-9469-06edd62954d7'
  21. formguid = 'e3244b32-286b-e611-9469-06edd62954d7'
  22. resourceguid = '36bee8ab-4e39-4f1d-b713-4eefa521fcd8'
  24. #define the assessor resource (need both guid & name)
  25. resource = assetic.Assetic3IntegrationRepresentationsRsResourceRepresentation()
  26. resource.id = resourceguid
  27. resource.display_name = 'Kevin Wilton'
  29. ##build the data. Structure of this changes for each form
  30. ##use the form API to get structure
  31. data = {"CONTROL0766":"1",
  32. "CONTROL0770":True,
  33. "CONTROL0771":"Tea Tree",
  34. "CONTROL07712":"melaleuca alternifolia"}
  36. #build the object to create the result entry
  37. form_result = assetic.Assetic3IntegrationRepresentationsAsmtFormResultRepresentation()
  38. form_result.form_id = formguid
  39. form_result.form_result_comment='created via api'
  40. form_result.form_result_start_time = datetime.isoformat(datetime.now() +
  41. timedelta(days=-7))
  42. form_result.form_result_end_time = datetime.isoformat(datetime.now()
  43. + timedelta(days=-5))
  44. form_result.form_result_last_modified = datetime.isoformat(datetime.now())
  45. form_result.form_result_status = 1
  46. form_result.form_result_rs_resource_id_assessed_by=resource
  47. form_result.data = data
  48. ##execute the post
  49. try:
  50. response = assessresultapi.assessment_form_result_post(form_result)
  51. except assetic.rest.ApiException as e:
  52. ##Log exception and exit
  53. asseticsdk.logger.error("Status {0}, Reason: {1}".format(e.status,e.reason))
  54. exit();
  55. ##check for error messages
  56. if response.get('Errors') != None:
  57. print(response.get('Errors'))
  58. exit();
  60. ##get response ID
  61. id = response['Data'][0]['Id']
  62. print(id)
  64. ##now link form result with task. First create api instance
  65. taskapi = assetic.AssessmentTaskApi()
  66. try:
  67. linkresponse = taskapi.assessment_task_link_asmt_form_result(taskguid,id)
  68. except assetic.rest.ApiException as e:
  69. #Log exception and exit
  70. asseticsdk.logger.error("Status {0}, Reason: {1}".format(e.status,e.reason))
  71. exit();
  72. print (linkresponse) #expect 'True'